Детальная информация о заказе

Запрос позволяет получить информацию о заказе клиента.

Синтаксис запроса

GET https://business.taxi.yandex.ru/api/1.0/client/{идентификатор клиента}/order/{идентификатор заказа}

🔴 Рекомендуем использовать API 2.0. Поддержка API 1.0 в будущем будет прекращена.

Заголовки запроса:

Authorization

OAuth-токен. Процесс получения токена описан в разделе Начало работы.

Запрос может содержать следующие необязательные аргументы:

  • show_cancel_text — признак того, что в ответе будет содержаться информация о способах отмены заказа. Возможные значения:
    • true — ответ с информацией об отмене.
    • false — ответ без информации об отмене. Значение по умолчанию.

Описание полей ответа

В ответе могут содержаться следующие поля:

Поле Описание Формат
_id Идентификатор заказа. Строка
status Блок статуса заказа. Содержит следующие поля:
- full.		 Объект
status.full Статус заказа. Возможные значения:
- search — заказ создан и осуществляется поиск водителя.
- driving — водитель найден и едет к месту подачи автомобиля.
- waiting — водитель прибыл и ожидает сотрудника.
- transporting — сотрудник сел в машину и находится в пути.
- complete — заказ завершен успешно.
- cancelled — заказ отменен по инициативе клиента или его сотрудника.
- failed — заказ отменен таксопарком, так как водитель не может его выполнить.
- expired — статус заказа неизвестен. Данный статус может возвращается, если таксопарк вовремя не прислал данные о состоянии заказа.
- scheduling — заказ создан, поиск водителя будет начат за некоторое время до подачи автомобиля.
- scheduled — заказ создан, водитель назначен и выедет к сотруднику согласно времени подачи. Заказ в этом статусе может быть изменен.		 Строка
due_date Время, к которому необходимо завершить поездку. Формат значений: YYYY-MM-DDThh:mm:ss(±hhmm). Строка
finished_date Дата фактического завершения поездки. Формат значений: YYYY-MM-DDThh:mm:ss(±hhmm). Строка
performer Блок с информацией об исполнителе заказа. Объект
car Название автомобиля. Строка
fullname Имя водителя. Строка
phone Телефонный номер водителя. Строка
corp_user Блок с информацией о пользователе. Объект
user_id Идентификационный номер пользователя. Строка
destination Блок с информацией о месте назначения поездки. Объект
fullname Полный адрес. Строка
geopoint Блок с координатами места. Формат параметра:[долгота,широта] Массив
source Блок с информацией о месте начала поездки. Объект
cancel_rules Блок с информацией об отмене заказа. Объект
can_cancel Признак возможности отменить заказ. Логическое
message Текстовое описание правил отмены заказа. Строка
state Условия отмены заказа. Возможные значения:
- free — бесплатная отмена.
- minimal — отмена с оплатой только стоимости подачи машины.
- paid — отмена с полной оплатой поездки.		 Строка
title Название правил отмены. Строка
cost Стоимость поездки. Число
cost_with_vat Стоимость поездки с НДС. Число
class Тариф поездки. Строка
cost_center Название центра затрат клиента. Строка
cost_center_values Новые поля центров затрат. Массив
cost_center_values.[N].id id поля центров затрат. Строка
cost_center_values.[N].title Название поля центров затрат. Строка
cost_center_values.[N].value Значение поля центров затрат для данного заказа. Строка
created_by Имя создателя заказа. Строка

Пример запроса

GET https://business.taxi.yandex.ru/api/1.0/client/a2...d09/order/8b...e432?show_cancel_text=true
...
Authorization: <OAuth-токен>

Пример ответа

Пример ответа на данный запрос выглядит следующим образом:

{
    "_id": "8b8de2e41d204f42b0a775b2edd6e432",
    "status": "finished",
    "due_date": "2016-03-24T21:37:17",
    "finished_date": "2016-03-24T21:47:17",
    "performer": {
        "car": "Volkswagen Caravelle коричневый А123ВЕ",
        "fullname": "Сергей",
        "phone": "+75551234567"
    },
    "corp_user": {
        "user_id": "88eaf8ef4d8b4d8384f6064da13a1680"
    },
    "destination": {
        "fullname": "Россия, Москва, Большая Никитская улица, 13",
        "geopoint": [
            "37.600296",
            "55.750379"
        ]
    },
    "source": {
        "fullname": "Россия, Москва, улица Тимура Фрунзе, 11к8",
        "geopoint": [
            "37.5887876121",
            "55.734141752"
        ]
    },
    "cancel_rules": {
        "can_cancel": true,
        "message": "Сейчас отмена бесплатна. После приезда водителя за это, возможно, придётся платить",
        "state": "free",
        "title": "Бесплатная отмена"
    },
    "cost": 540,
    "cost_with_vat": 680,
    "class": "econom",
    "cost_center": "some cost center",
    "cost_centers": [
        {
            "id": "cost_center",
            "title": "Центр затрат",
            "value": "командировка"
        },
        {
            "id": "0123456789abcdef0123456789abcde1",
            "title": "Цель поездки",
            "value": "особая цель"
        }
    ],
    "created_by": "Менеджер Анна"
}

Возможные коды ответа

Ответ на данный запрос может содержать следующие стандартные HTTP-коды:

  • 200 — запрос выполнен успешно.
  • 401 — был передан неверный OAuth-токен.
  • 403 — у клиента не хватает прав на выполнение данного запроса.
  • 404 — запрашиваемая запись не найдена.
Предыдущая
Отменить заказ
Следующая
Отслеживание заказа